Verbosity cleanup and reduced warnings/printouts #636

jkirk5 · 2024-12-26T19:09:57Z

Summary

Made a variety of updates related to Aviary's printouts and giving users more control over them, as well as some related housekeeping items while I was looking at that part of the code.

Printouts

Overhauled the pyoptsparse and optimizer printouts to provide less information (mostly unneeded/redundant with reports) across the board for all verbosities except DEBUG.
Eliminated unnecessary openmdao and dymos printouts.
Added a number of verbosity checks on other print statements throughout Aviary (not comprehensive).
Tweaked a number of aircraft models to avoid preprocessor warnings about ambiguous inputs (such as providing NUM_ENGINES but not NUM_WING_ENGINES (not comprehensive).

Verbosity

Verbosity can now be set independently of what is in the .csv or AviaryValues object when using the Python interface (L1 or L2) as well as from the CLI
- run_aviary() now has a verbosity argument which overrides whatever is in the aircraft data. Can be passed via CLI.
- Relevant methods in method_for_level2.py have optional verbosity arguments which override any other verbosity sources for that method call only. In case you want to run a specific step with higher/lower verbosity when using L2.
Switched a large number of tests to QUIET verbosity, including all benchmark tests.
The default optimizer for AviaryProblem is now IPOPT instead of SNOPT.
Default verbosity now pulls from metadata instead of being hardcoded (still BRIEF).

Bugfixes

AviaryProblems now uses openmdao default problem name when given an AviaryValues, instead of trying to name it off of the filename Path().stem.

All of methods_for_level2.py got the autoformat treatment since I touched a bunch of pieces of it - makes for a messy diff, but this file was very inconsistently styled, IMO it needed to be done.

Related Issues

Resolves #

Backwards incompatibilities

API changes - Level 2

run_aviary(): renamed aircraft_filename argument to aircraft_data to reflect capability to provide an AviaryValues object instead of a filepath.

New Dependencies

None

Renamed input_filename argument to input_data

more verbosity updates for preprocessor stack

verbosity updates

aviary/interface/methods_for_level2.py

…eanup

Kenneth-T-Moore · 2025-01-07T21:53:23Z

.gitignore

@@ -131,6 +131,8 @@ dmypy.json

 # Test and spec generated
 reports/
+aviary/reports/
+*.openmdao_out


Just want to make sure you know about the openmdao clean command, for cleaning up all of these directories.
https://openmdao.org/newdocs/versions/latest/other_useful_docs/om_command.html#openmdao-clean

Kenneth-T-Moore · 2025-01-07T21:54:43Z

aviary/docs/examples/outputted_phase_info.py

@@ -1,2 +1,21 @@
-phase_info = {'pre_mission': {'include_takeoff': True, 'optimize_mass': True}, 'climb_1': {'subsystem_options': {'core_aerodynamics': {'method': 'computed'}}, 'user_options': {'optimize_mach': True, 'optimize_altitude': True, 'polynomial_control_order': [1, 2], 'use_polynomial_control': True, 'num_segments': [1], 'order': 1, 'solve_for_distance': True, 'initial_mach': (1, None), 'final_mach': (2, None), 'mach_bounds': (
-    (0.98, 2.02), None), 'initial_altitude': (1, None), 'final_altitude': (2, None), 'altitude_bounds': ((0.0, 502), None), 'throttle_enforcement': 'path_constraint', 'fix_initial': True, 'constrain_final': True, 'fix_duration': False, 'initial_bounds': ((0.0, 0.0), None), 'duration_bounds': ((0.5, 1.5), None)}, 'initial_guesses': {'time': ([1, 1], None)}}, 'post_mission': {'include_landing': True, 'constrain_range': True, 'target_range': (514.5, None)}}
+phase_info = {


This file is proving to be a problem. I think we need it for some glue stuff, but it is auto-generated, so always has to be fixed every time we run the docs.

Kenneth-T-Moore · 2025-01-07T21:55:44Z

aviary/docs/getting_started/onboarding_level1.ipynb

@@ -223,50 +223,9 @@
    "\n",
    "To find information about a variable (e.g. description, data type, etc.), users should read the [Variable Metadata Doc](../user_guide/variable_metadata).\n",
    "\n",
-    "There are special rules for the mapping from the input file variable names to the metadata. For example, variable `aircraft:wing:aspect_ratio` in `aircraft_for_bench_GwGm.csv` is mapped to `Aircraft.Wing.ASPECT_RATIO` in `aviary/variable_info/variable_meta_data.py`. So, the first part (e.g., `aircraft` or `mission`) is mapped to the same word but with the first letter capitalized (e.g., `Aircraft` or `Mission`). The third word is all caps (e.g., `ASPECT_RATIO`). The middle part (e.g., `wing`) is a little more complicated. In most cases, this part capitalizes the first letter (e.g., `Wing`). The following words have special mappings:\n",
+    "Variable names may be differently within the code from how they are formatted inside OpenMDAO components and in input files and outputs. For example, variable `aircraft:wing:aspect_ratio` in `aircraft_for_bench_GwGm.csv` is mapped to `Aircraft.Wing.ASPECT_RATIO` in `aviary/variable_info/variable_meta_data.py`. This is because OpenMDAO requires variable names to be strings, but for developer convenience those strings are mapped to Python classes and attributes. The top-level and sub-categories have capitalized first letters, and the final variable name is always in all-caps. For more information on Aviary's variable hierarchy, see the [Variable Hierarchy doc](../user_guide/variable_hierarchy.ipynb).\n",


wording : "may be differently..." --> "may appear differently..."

Kenneth-T-Moore · 2025-01-07T22:05:31Z

aviary/subsystems/mass/flops_based/wing_detailed.py

-                inertia_factor[i] = 1 - bte / bt * pod_mass[i] / gross_mass
+                inertia_factor_i = 1 - bte / bt * pod_mass[i] / gross_mass
+                # avoid passing an array into specific index of inertia_factor
+                inertia_factor[i] = inertia_factor_i[0]


It doesn't look like this should ever become a vector, so if it does, then there is something that should be fixed on one of the variables.

Good point. I did some digging and somehow gross mass input is a vector, despite being set as a float in do_validation_tests.py (through prob.set_val()). Not sure how this is happening...

Kenneth-T-Moore · 2025-01-07T22:07:31Z

aviary/models/large_turboprop_freighter/phase_info.py

@@ -217,7 +217,7 @@
            'num_segments': 1,
            'order': 3,
            'fix_initial': False,
-            'EAS_target': (250, 'kn'),
+            'EAS_target': (150, 'kn'),


Kind of some big changes to the turboprop mission.

Kenneth-T-Moore · 2025-01-07T22:10:43Z

aviary/interface/methods_for_level2.py

@@ -26,11 +26,15 @@
 from aviary.mission.flops_based.phases.build_landing import Landing
 from aviary.mission.flops_based.phases.build_takeoff import Takeoff
 from aviary.mission.twodof_phase import TwoDOFPhase
-from aviary.mission.gasp_based.idle_descent_estimation import add_descent_estimation_as_submodel
+from aviary.mission.gasp_based.idle_descent_estimation import (


Doing the auto-PEP on this file might make it very difficult to merge the changes into the level 2 refactor that is part of the epic that Eliot is working on.

This PR isn't time sensitive, I don't mind waiting until after that work gets merged in

Addressed review comments

… docs)

…eanup

jkirk5 added 14 commits December 20, 2024 11:39

Updated printout control using verbosity

a524869

Renamed input_filename argument to input_data

fix warnings appearing in tests

834f677

added backup for failed benchmark tests due to mpi failure

2c494bf

Merge remote-tracking branch 'remotes/origin/main' into cleanup

c3e394f

fixed missing variable & updated associated tests

c7f3072

mass variable naming updates

7102ba6

test bench cleanup

bcc5bcd

verbosity updates

546e2ca

updates for turboprop

745c921

more verbosity updates for preprocessor stack

adjustments to turboprop bench

79fb3b9

update optimizer printouts for SLSQP

fda0b55

variable desc cleanup

c8e2529

verbosity updates

more test verbosity updates

c846ad8

fixed default verbosity for preprocessors when not provided when user

7304904

jkirk5 changed the title ~~Verbosity cleanup roundl;i'~~ Verbosity cleanup round Dec 26, 2024

another round of test verbosity updates/fixes

78fad60

jkirk5 commented Dec 26, 2024

View reviewed changes

aviary/interface/methods_for_level2.py Outdated Show resolved Hide resolved

jkirk5 and others added 10 commits December 26, 2024 14:48

Update aviary/interface/methods_for_level2.py

32d38d8

better comments in L2

4567556

suppress multimission bench plot

ba8d89d

Merge branch 'cleanup' of https://github.com/jkirk5/om-Aviary into cl…

8e5d288

…eanup

cleaner verbosity comments for L2

c3e49af

more verbosity fixes for tests

b21d704

formatting fixes

3dec4d1

fixes for doc glue checks

6c3b9e3

fix invalid char warning for regex

935a023

doc updates

e1bad53

jkirk5 changed the title ~~Verbosity cleanup round~~ Verbosity cleanup and reduced warnings/printouts Dec 27, 2024

jkirk5 added 2 commits December 30, 2024 10:47

formatting fix

844dab7

properly incremented version number

70e4127

jkirk5 added 2 commits December 31, 2024 15:14

mach -> Mach in comments/docstrings

8b02f1a

Merge remote-tracking branch 'remotes/origin/main' into cleanup

11b14f0

Kenneth-T-Moore reviewed Jan 7, 2025

View reviewed changes

jkirk5 and others added 9 commits January 14, 2025 14:36

add skip for OAS test if ambiance not installed

a319a15

Merge remote-tracking branch 'remotes/origin/main' into cleanup

bd9caa0

minor cleanup

952e499

CI fixes

d8ccd5d

Addressed review comments

removed docs artifact file (it should be generated while building the…

129ea20

… docs)

Merge branch 'main' into cleanup

e27ab1c

Merge branch 'main' into cleanup

f42cab0

Merge remote-tracking branch 'remotes/origin/units' into cleanup

a66c80d

Merge branch 'cleanup' of https://github.com/jkirk5/om-Aviary into cl…

0b1ccf3

…eanup

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Verbosity cleanup and reduced warnings/printouts #636

Verbosity cleanup and reduced warnings/printouts #636

jkirk5 commented Dec 26, 2024 •

edited

Loading

Kenneth-T-Moore Jan 7, 2025

Kenneth-T-Moore Jan 7, 2025

Kenneth-T-Moore Jan 7, 2025

Kenneth-T-Moore Jan 7, 2025

jkirk5 Jan 16, 2025

Kenneth-T-Moore Jan 7, 2025

Kenneth-T-Moore Jan 7, 2025

jkirk5 Jan 8, 2025

Verbosity cleanup and reduced warnings/printouts #636

Are you sure you want to change the base?

Verbosity cleanup and reduced warnings/printouts #636

Conversation

jkirk5 commented Dec 26, 2024 • edited Loading

Summary

Related Issues

Backwards incompatibilities

New Dependencies

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkirk5 commented Dec 26, 2024 •

edited

Loading